chore: improve mock asset controller data source tests by Prithpal-Sooriya · Pull Request #7958 · MetaMask/core

Prithpal-Sooriya · 2026-02-17T17:32:06Z

Explanation

This commit introduces a new mock implementation of the AssetControllerMessenger, which facilitates testing by simulating various actions and events related to asset management. The mock includes methods for creating a mock provider, registering action handlers, and simulating network states. Additionally, it updates the RpcDataSource and StakedBalanceDataSource tests to utilize the new mock, improving test reliability and coverage.

Refactors existing tests to remove unnecessary complexity and improve clarity, ensuring that the mock accurately reflects the expected behavior of the real messenger in a controlled environment.

References

Checklist

I've updated the test suite for new or updated code as appropriate
I've updated documentation (JSDoc, Markdown, etc.) for new or updated code as appropriate
I've communicated my changes to consumers by updating changelogs for packages I've changed
I've introduced breaking changes in this PR and have prepared draft pull requests for clients and consumer packages to resolve them

Note

Medium Risk
Mostly test-only refactors, but it changes StakedBalanceDataSource subscription teardown behavior to rely on messenger-level cleanup, which could affect consumers with custom messenger implementations.

Overview
Improves assets-controller data source tests by introducing a shared MockAssetControllerMessenger fixture that delegates the relevant actions/events and provides helpers for registering RPC/staking handlers and mocking a Web3Provider.

Updates RpcDataSource and StakedBalanceDataSource tests to use the shared fixture, simplify network-state/event publishing via the root messenger, and tighten event-driven staking refresh assertions. Also exports STAKING_INTERFACE for reuse in mocks and makes small type-safety cleanups in RpcDataSource around state/token-list access and native asset ID construction.

^{Written by Cursor Bugbot for commit b2c402c. This will update automatically on new commits. Configure here.}

This commit introduces a new mock implementation of the AssetControllerMessenger, which facilitates testing by simulating various actions and events related to asset management. The mock includes methods for creating a mock provider, registering action handlers, and simulating network states. Additionally, it updates the RpcDataSource and StakedBalanceDataSource tests to utilize the new mock, improving test reliability and coverage. Refactors existing tests to remove unnecessary complexity and improve clarity, ensuring that the mock accurately reflects the expected behavior of the real messenger in a controlled environment.

Prithpal-Sooriya · 2026-02-17T17:32:29Z

packages/assets-controller/src/__fixtures__/MockAssetControllerMessenger.ts

+
+// Test escape hatch for mocking areas that do not need explicit types
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+type TestMockType = any;


Only 1 or 2 places are using the escape hatch 🤞🏾

Prithpal-Sooriya · 2026-02-17T17:33:27Z

packages/assets-controller/src/__fixtures__/MockAssetControllerMessenger.ts

+  rootMessenger.delegate({
+    messenger: assetsControllerMessenger,
+    actions: [
+      // AssetsController
+      'AccountTreeController:getAccountsFromSelectedAccountGroup',
+      // RpcDataSource
+      'TokenListController:getState',
+      'NetworkController:getState',
+      'NetworkController:getNetworkClientById',
+      // RpcDataSource, StakedBalanceDataSource
+      'NetworkEnablementController:getState',
+      // SnapDataSource
+      'SnapController:getRunnableSnaps',
+      'SnapController:handleRequest',
+      'PermissionController:getPermissions',
+      // BackendWebsocketDataSource
+      'BackendWebSocketService:connect',
+      'BackendWebSocketService:disconnect',
+      'BackendWebSocketService:forceReconnection',
+      'BackendWebSocketService:sendMessage',
+      'BackendWebSocketService:sendRequest',
+      'BackendWebSocketService:getConnectionInfo',
+      'BackendWebSocketService:getSubscriptionsByChannel',
+      'BackendWebSocketService:channelHasSubscription',
+      'BackendWebSocketService:findSubscriptionsByChannelPrefix',
+      'BackendWebSocketService:addChannelCallback',
+      'BackendWebSocketService:removeChannelCallback',
+      'BackendWebSocketService:getChannelCallbacks',
+      'BackendWebSocketService:subscribe',
+    ],
+    events: [
+      // AssetsController
+      'AccountTreeController:selectedAccountGroupChange',
+      'KeyringController:lock',
+      'KeyringController:unlock',
+      'PreferencesController:stateChange',
+      // RpcDataSource, StakedBalanceDataSource
+      'NetworkController:stateChange',
+      'TransactionController:transactionConfirmed',
+      'TransactionController:incomingTransactionsReceived',
+      // StakedBalanceDataSource
+      'NetworkEnablementController:stateChange',
+      // SnapDataSource
+      'AccountsController:accountBalancesUpdated',
+      'PermissionController:stateChange',
+      // BackendWebsocketDataSource
+      'BackendWebSocketService:connectionStateChanged',
+    ],
+  });


Yeah lets def sync on the AssetController messenger.
This messenger has way too many responsibilities.

Ideally each data source should have its own responsibilities.

Prithpal-Sooriya · 2026-02-17T17:33:44Z

packages/assets-controller/src/__fixtures__/MockAssetControllerMessenger.ts

+      'BackendWebSocketService:connect',
+      'BackendWebSocketService:disconnect',
+      'BackendWebSocketService:forceReconnection',
+      'BackendWebSocketService:sendMessage',
+      'BackendWebSocketService:sendRequest',
+      'BackendWebSocketService:getConnectionInfo',
+      'BackendWebSocketService:getSubscriptionsByChannel',
+      'BackendWebSocketService:channelHasSubscription',
+      'BackendWebSocketService:findSubscriptionsByChannelPrefix',
+      'BackendWebSocketService:addChannelCallback',
+      'BackendWebSocketService:removeChannelCallback',
+      'BackendWebSocketService:getChannelCallbacks',
+      'BackendWebSocketService:subscribe',


Does the asset controller really need ALL the backend actions?

packages/assets-controller/src/data-sources/StakedBalanceDataSource.ts

…DataSource This commit cleans up the `destroy` method in the `StakedBalanceDataSource` class by removing the unsubscription logic for transaction and network events, which is no longer necessary. Corresponding test cases have also been removed to reflect this change.

Prithpal-Sooriya · 2026-02-17T17:46:34Z

packages/assets-controller/src/data-sources/StakedBalanceDataSource.ts

      this.#handleStakedBalanceUpdate.bind(this),
    );

-    const unsubConfirmed = this.#messenger.subscribe(


.subscribe does not return a callback, so this was not needed.

Prithpal-Sooriya · 2026-02-17T17:46:47Z

packages/assets-controller/src/data-sources/StakedBalanceDataSource.ts

-    this.#unsubscribeTransactionConfirmed?.();
-    this.#unsubscribeIncomingTransactions?.();
-    this.#unsubscribeNetworkStateChange?.();
-    this.#unsubscribeNetworkEnablementControllerStateChange?.();


There is no callback to unsubscribe from.

Prithpal-Sooriya · 2026-02-17T17:48:15Z

packages/assets-controller/src/data-sources/StakedBalanceDataSource.test.ts

    });
  });
-
-  describe('destroy', () => {


Test is irrelevant. The controller destruction will clear messenger subscriptions.

BUT we share this messenger with other data sources, so a data source destruction might impact other data sources 💀

We can discuss delegating and generating diff messengers per data source.

cursor

Cursor Bugbot has reviewed your changes and found 2 potential issues.

packages/assets-controller/src/data-sources/StakedBalanceDataSource.ts

packages/assets-controller/src/data-sources/StakedBalanceDataSource.test.ts

salimtb

tested and work as expected

## Explanation This commit introduces a new mock implementation of the AssetControllerMessenger, which facilitates testing by simulating various actions and events related to asset management. The mock includes methods for creating a mock provider, registering action handlers, and simulating network states. Additionally, it updates the RpcDataSource and StakedBalanceDataSource tests to utilize the new mock, improving test reliability and coverage. Refactors existing tests to remove unnecessary complexity and improve clarity, ensuring that the mock accurately reflects the expected behavior of the real messenger in a controlled environment. ## References  ## Checklist - [x] I've updated the test suite for new or updated code as appropriate - [x] I've updated documentation (JSDoc, Markdown, etc.) for new or updated code as appropriate - [x] I've communicated my changes to consumers by [updating changelogs for packages I've changed](https://github.com/MetaMask/core/tree/main/docs/processes/updating-changelogs.md) - [x] I've introduced [breaking changes](https://github.com/MetaMask/core/tree/main/docs/processes/breaking-changes.md) in this PR and have prepared draft pull requests for clients and consumer packages to resolve them  --- > [!NOTE] > **Medium Risk** > Mostly test-only refactors, but it changes `StakedBalanceDataSource` subscription teardown behavior to rely on messenger-level cleanup, which could affect consumers with custom messenger implementations. > > **Overview** > Improves `assets-controller` data source tests by introducing a shared `MockAssetControllerMessenger` fixture that delegates the relevant actions/events and provides helpers for registering RPC/staking handlers and mocking a `Web3Provider`. > > Updates `RpcDataSource` and `StakedBalanceDataSource` tests to use the shared fixture, simplify network-state/event publishing via the root messenger, and tighten event-driven staking refresh assertions. Also exports `STAKING_INTERFACE` for reuse in mocks and makes small type-safety cleanups in `RpcDataSource` around state/token-list access and native asset ID construction. > > <sup>Written by [Cursor Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit b2c402c. This will update automatically on new commits. Configure [here](https://cursor.com/dashboard?tab=bugbot).</sup>

Prithpal-Sooriya requested a review from a team as a code owner February 17, 2026 17:32

Prithpal-Sooriya commented Feb 17, 2026

View reviewed changes

cursor bot reviewed Feb 17, 2026

View reviewed changes

packages/assets-controller/src/data-sources/StakedBalanceDataSource.ts Outdated Show resolved Hide resolved

docs: update changelog

1e4b4ec

Prithpal-Sooriya requested a review from a team as a code owner February 17, 2026 17:43

Prithpal-Sooriya commented Feb 17, 2026

View reviewed changes

cursor bot reviewed Feb 17, 2026

View reviewed changes

packages/assets-controller/src/data-sources/StakedBalanceDataSource.ts Show resolved Hide resolved

packages/assets-controller/src/data-sources/StakedBalanceDataSource.test.ts Show resolved Hide resolved

salimtb approved these changes Feb 18, 2026

View reviewed changes

Prithpal-Sooriya added this pull request to the merge queue Feb 18, 2026

Merged via the queue into main with commit c3169f5 Feb 18, 2026
306 checks passed

Prithpal-Sooriya deleted the refactor/clean-up-data-source-tests branch February 18, 2026 09:55

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Comments

chore: improve mock asset controller data source tests#7958

chore: improve mock asset controller data source tests#7958
Prithpal-Sooriya merged 3 commits intomainfrom
refactor/clean-up-data-source-tests

Prithpal-Sooriya commented Feb 17, 2026 •

edited by cursor bot

Loading

Uh oh!

Prithpal-Sooriya Feb 17, 2026

Uh oh!

Prithpal-Sooriya Feb 17, 2026

Uh oh!

Prithpal-Sooriya Feb 17, 2026

Uh oh!

Uh oh!

Prithpal-Sooriya Feb 17, 2026

Uh oh!

Prithpal-Sooriya Feb 17, 2026

Uh oh!

Prithpal-Sooriya Feb 17, 2026

Uh oh!

cursor bot left a comment

Uh oh!

Uh oh!

Uh oh!

salimtb left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Comments

Conversation

Prithpal-Sooriya commented Feb 17, 2026 • edited by cursor bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Explanation

References

Checklist

Uh oh!

Prithpal-Sooriya Feb 17, 2026

Choose a reason for hiding this comment

Uh oh!

Prithpal-Sooriya Feb 17, 2026

Choose a reason for hiding this comment

Uh oh!

Prithpal-Sooriya Feb 17, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Prithpal-Sooriya Feb 17, 2026

Choose a reason for hiding this comment

Uh oh!

Prithpal-Sooriya Feb 17, 2026

Choose a reason for hiding this comment

Uh oh!

Prithpal-Sooriya Feb 17, 2026

Choose a reason for hiding this comment

Uh oh!

cursor bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

salimtb left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Prithpal-Sooriya commented Feb 17, 2026 •

edited by cursor bot

Loading